﻿/*
 * The MIT License (MIT)
 * Copyright (c) 2017 Johan Karlsson
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy 
 * of this software and associated documentation files (the "Software"), to deal 
 * in the Software without restriction, including without limitation the rights 
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
 * copies of the Software, and to permit persons to whom the Software is furnished 
 * to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in 
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
 * DEALINGS IN THE SOFTWARE.
 *
 */

using System.Net.Http;

namespace TinyHttpClientPoolLib
{
    public interface ITinyHttpClientPool
    {
        /// <summary>
        /// Gets the count of HttpClients that are ready to be used
        /// </summary>
        /// <value>The available count</value>
        int AvailableCount { get; }

        /// <summary>
        /// Gets the total size of the pool excluding disposed but not cleared HttpClients
        /// </summary>
        /// <value>The total size of the pool</value>
        int TotalPoolSize { get; }

        /// <summary>
        /// Fetches or creates a new instance of a HttpClient from the pool
        /// </summary>
        /// <returns>The fetch.</returns>
        HttpClient Fetch();

        /// <summary>
        /// Flushes the pool and disposes all HttpClients that are not in use
        /// </summary>
        void Flush();
    }
}
